package org.mysofts.eclipseman.launch.util;

import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.List;

import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.HelpFormatter;
import org.apache.commons.cli.Option;
import org.apache.commons.cli.Options;
import org.apache.commons.cli.ParseException;
import org.apache.commons.cli.Parser;
import org.apache.commons.cli.PosixParser;

/**
 * Launcher abstrait pour parser une ligne de commande.
 * 
 * @author reda
 * 
 */
public abstract class AbstractLauncher { // $codepro.audit.disable
											// declareDefaultConstructors
	/**
	 * Code de retour d'erreur dans les arguments.
	 */
	private static final int ARG_ERROR_EXIT_CODE = 1;
	/**
	 * Code de retour d'erreur fonctionnelle.
	 */
	private static final int FUNC_ERROR_EXIT_CODE = 2;
	/**
	 * Chaine de caractère 'OK'.
	 */
	protected static final String OK = "OK";
	/**
	 * Chaine de caractère 'NOK'.
	 */
	protected static final String NOK = "NOK";
	/**
	 * Options.
	 */
	private final Options options;
	/**
	 * Commande.
	 */
	private final String command;

	/**
	 * Constructeur.
	 * 
	 * @param command
	 *            Nom de la commande.
	 * @param args
	 *            Arguments.
	 */
	protected AbstractLauncher(final String command, final String[] args) {
		this.command = command;
		this.options = new Options();
		final List<Option> optlist = new ArrayList<Option>();
		createOptions(optlist);
		for (Option opt : optlist) {
			this.options.addOption(opt);
		}
		
		try {
			final Parser parser = new PosixParser();
			final CommandLine tCommandLine = parser.parse(this.options, args);
			final String[] tArguments = tCommandLine.getArgs();
			parseOptions(tCommandLine);
			parseArguments(tArguments);
		} catch (ParseException e) {
			showError(e.getMessage(), ARG_ERROR_EXIT_CODE, false);
		}
	}

	/**
	 * Affiche un message d'erreur et quitte l'application.
	 * 
	 * @param message
	 *            Message d'erreur.
	 * @param exitCode
	 *            code de sortie.
	 * @param showHelp
	 *            Affiche l'aide.
	 */
	public final void showError(final String message, final int exitCode,
			final boolean showHelp) {
		System.err.println(MessageFormat.format("ERREUR: {0}", message));
		if (showHelp) {
			final HelpFormatter helpFormatter = new HelpFormatter();
			helpFormatter.printHelp(this.command, this.options);
		} // end if
		System.exit(exitCode); // $codepro.audit.disable
	}

	/**
	 * Affiche un message d'erreur et quitte l'application avec le code de
	 * retour 2.
	 * 
	 * @param message
	 *            Message d'erreur.
	 */
	public final void functionnalError(final String message) {
		this.showError(message, FUNC_ERROR_EXIT_CODE, false);
	}

	/**
	 * Parse les arguments de la ligne de commande.
	 * 
	 * @param args
	 *            arguments.
	 * @throws ParseException
	 *             erreur de parsing.
	 */
	protected abstract void parseArguments(String[] args) throws ParseException;

	/**
	 * Parse les options de la ligne de commande.
	 * 
	 * @param commandLine
	 *            Objet qui fournit les options.
	 * @throws ParseException
	 *             erreur de parsing.
	 */
	protected abstract void parseOptions(CommandLine commandLine)
			throws ParseException;

	/**
	 * Méthode qui crée les options de l'application.
	 * 
	 * @param optlist
	 *            liste qui doit recevoir les options créé.
	 */
	protected abstract void createOptions(List<Option> optlist);

}
